<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
<title>
  File: README
  
    &mdash; Documentation by YARD 0.8.7.6
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '';
  framesUrl = "frames.html#!file.README.html";
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div id="header">
      <div id="menu">
  
    <a href="_index.html">Index</a> &raquo; 
    <span class="title">File: README</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><div id='filecontents'><h1>KerbalStuff API Wrapper for Ruby</h1>

<p>A simple Ruby API Wrapper for KerbalStuff</p>

<h2>Gem Status</h2>

<p><a href="http://badge.fury.io/rb/KerbalStuff"><img src="https://badge.fury.io/rb/KerbalStuff.png" alt="Gem Version"></a></p>

<h2>Install</h2>

<p>You can install the gem like this:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_kerbalstuff'>kerbalstuff</span>
</code></pre>

<h2>Updating</h2>

<p>When a new update is released, you can update your gem like this:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_update'>update</span> <span class='id identifier rubyid_kerbalstuff'>kerbalstuff</span>
</code></pre>

<h2>Examples</h2>

<p>Here are some examples of how you can use the wrapper.</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>kerbalstuff</span><span class='tstring_end'>'</span></span> <span class='comment'># Require the Gem
</span></code></pre>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_ks'>ks</span> <span class='op'>=</span> <span class='const'>KerbalStuff</span> <span class='comment'># Initialize the wrapper
</span>
<span class='id identifier rubyid_ks'>ks</span><span class='period'>.</span><span class='id identifier rubyid_search_mod'>search_mod</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>parts pack</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># returns an array containing Mod objects.
</span><span class='id identifier rubyid_ks'>ks</span><span class='period'>.</span><span class='id identifier rubyid_search_user'>search_user</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>godarklight</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># returns an array containing User objects.
</span>
<span class='id identifier rubyid_ks'>ks</span><span class='period'>.</span><span class='id identifier rubyid_get_mod'>get_mod</span><span class='lparen'>(</span><span class='int'>4</span><span class='rparen'>)</span> <span class='comment'># returns a Mod object containing the information about the mod.
</span><span class='id identifier rubyid_ks'>ks</span><span class='period'>.</span><span class='id identifier rubyid_get_user'>get_user</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>RockyTV</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># returns a User object containing the information about the user.
</span>
<span class='id identifier rubyid_ks'>ks</span><span class='period'>.</span><span class='id identifier rubyid_get_latest_mod_version'>get_latest_mod_version</span><span class='lparen'>(</span><span class='int'>4</span><span class='rparen'>)</span> <span class='comment'># returns a ModVersion object containing information about the version.
</span>
<span class='id identifier rubyid_ks'>ks</span><span class='period'>.</span><span class='id identifier rubyid_browse'>browse</span><span class='lparen'>(</span> <span class='lbrace'>{</span><span class='symbol'>:page</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:orderby</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>name</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:order</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>asc</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:count</span> <span class='op'>=&gt;</span> <span class='int'>5</span><span class='rbrace'>}</span> <span class='rparen'>)</span> <span class='comment'># returns an Array containing mod objects
</span><span class='id identifier rubyid_ks'>ks</span><span class='period'>.</span><span class='id identifier rubyid_browse_recent'>browse_recent</span><span class='lparen'>(</span> <span class='lbrace'>{</span><span class='symbol'>:page</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='rbrace'>}</span> <span class='rparen'>)</span> <span class='comment'># returns an Array containing mod objects
</span><span class='id identifier rubyid_ks'>ks</span><span class='period'>.</span><span class='id identifier rubyid_browse_featured'>browse_featured</span><span class='lparen'>(</span> <span class='lbrace'>{</span><span class='symbol'>:page</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='rbrace'>}</span> <span class='rparen'>)</span> <span class='comment'># returns an Array containing mod objects
</span><span class='id identifier rubyid_ks'>ks</span><span class='period'>.</span><span class='id identifier rubyid_browse_top'>browse_top</span><span class='lparen'>(</span> <span class='lbrace'>{</span><span class='symbol'>:page</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='rbrace'>}</span> <span class='rparen'>)</span> <span class='comment'># returns an Array containing mod objects
</span>
</code></pre>

<h2>Documentation</h2>

<p>For a <em>slightly</em> more detailed version of the gem&#39;s methods, take a look <a href="http://rubydoc.info/gems/KerbalStuff/">here</a>.</p>

<h2>License</h2>

<p>licensed under MIT License Copyright (c) 2014 Alexandre Oliveira. See LICENSE for further details.</p>

<h2>Contributing</h2>

<p>See <a href="http://github.com/RockyTV/KerbalStuffGem/CONTRIBUTING.MD">CONTRIBUTING.MD</a></p>
</div></div>

    <div id="footer">
  Generated on Wed Dec 10 18:44:26 2014 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.7.6 (ruby-1.9.3).
</div>

  </body>
</html>